Added basic doc for dealing with DTO by lyrixx · Pull Request #369 · api-platform/docs

lyrixx · 2017-12-26T16:30:54Z

alanpoulain · 2017-12-26T16:41:25Z

+}
+```
+
+In this case, we disable all operation exept `POST`.


dunglas

Can you also make classes final please?

dunglas · 2017-12-26T16:37:19Z

+
+use ApiPlatform\Core\EventListener\EventPriorities;
+use App\Manager\UserManager;
+use Joli\Entity\User;


App\Entity\User?

dunglas · 2017-12-26T16:37:46Z

+
+## How to use a DTO for writing
+
+Sometimes it's easier to use a DTO than an Entity when performing simple that.


Extra "that" to remove?

dunglas · 2017-12-26T16:38:09Z

@@ -0,0 +1,116 @@
+# DTO - Data Transfer Object


May I suggest: Handling Data Transfer Objects (DTOs)

dunglas · 2017-12-26T16:38:29Z

@@ -0,0 +1,116 @@
+# DTO - Data Transfer Object
+
+## How to use a DTO for writing


We use title case for titles: How to use a DTO for Writing

dunglas · 2017-12-26T16:39:17Z

+## How to use a DTO for writing
+
+Sometimes it's easier to use a DTO than an Entity when performing simple that.
+For exemple, if the application should be able to send an email when someone has


dunglas · 2017-12-26T16:39:36Z

+}
+```
+
+In this case, we disable all operation exept `POST`.


operations except

dunglas · 2017-12-26T16:40:21Z

+
+In this case, we disable all operation exept `POST`.
+
+Then, thanks to the [the event system](events.md), it's possible to intercept


double the

dunglas · 2017-12-26T16:40:52Z

+    public static function getSubscribedEvents()
+    {
+        return [
+            KernelEvents::VIEW => [


IIRC, you can remove the outer array.

yes it's possible. But usually the listener can be re-used to handle many operation.
And it could avoid api-platform/core#1590 (comment)

Anyway, I removed the outer array

alanpoulain · 2017-12-26T16:41:51Z

+## How to use a DTO for writing
+
+Sometimes it's easier to use a DTO than an Entity when performing simple that.
+For exemple, if the application should be able to send an email when someone has


For example, the application should be able to send an email when someone has lost its password.

alanpoulain · 2017-12-26T16:42:01Z

+
+## How to use a DTO for writing
+
+Sometimes it's easier to use a DTO than an Entity when performing simple that.


alanpoulain · 2017-12-26T16:43:20Z

+}
+```
+
+Then this class should be registred as a service, then tagged.


lyrixx · 2017-12-27T09:32:46Z

@alanpoulain & @dunglas Thanks for the review. I have addressed your comments.

dunglas · 2017-12-27T09:54:49Z

Thanks @lyrixx! Great piece of docs.

aitboudad · 2017-12-27T16:52:36Z

added one missing step in #371

aitboudad · 2017-12-27T17:13:16Z

+    {
+        $request = $event->getRequest();
+
+        if ('api_forgot_password_requests_post_collection' !== $request->attributes->get('_route')) {


wouldn't better to check the model instance instead ?

if ( !Request::METHOD_POST === $request->getMethod() || !$event->getControllerResult() instanceof ForgotPasswordRequest ) { return; }

Actually, Now I prefer to match the route name. This reduce side effect.

But anyway, It's not really perfect IMHO

ahh ok, IMO there is no perfect way ;)

alanpoulain reviewed Dec 26, 2017

View reviewed changes

Comment thread core/dto.md Outdated

}

```

In this case, we disable all operation exept `POST`.

alanpoulain Dec 26, 2017

Copy link
Copy Markdown

Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

except

dunglas requested changes Dec 26, 2017

View reviewed changes

alanpoulain reviewed Dec 26, 2017

View reviewed changes

Added basic doc for dealing with DTO

e8f3dbe

lyrixx force-pushed the dto branch from c111802 to e8f3dbe Compare December 27, 2017 09:32

Update dto.md

3922ad0

dunglas approved these changes Dec 27, 2017

View reviewed changes

dunglas merged commit 5cbe6b0 into api-platform:master Dec 27, 2017

lyrixx deleted the dto branch December 27, 2017 11:13

aitboudad reviewed Dec 27, 2017

View reviewed changes


		## How to use a DTO for writing

		Sometimes it's easier to use a DTO than an Entity when performing simple that.

		@@ -0,0 +1,116 @@
		# DTO - Data Transfer Object

		## How to use a DTO for writing


		In this case, we disable all operation exept `POST`.

		Then, thanks to the [the event system](events.md), it's possible to intercept

Uh oh!

Uh oh!

Conversation

lyrixx commented Dec 26, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dunglas left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alanpoulain Dec 26, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lyrixx commented Dec 27, 2017

Uh oh!

dunglas commented Dec 27, 2017

Uh oh!

aitboudad commented Dec 27, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

alanpoulain Dec 26, 2017 •

edited

Loading

aitboudad commented Dec 27, 2017 •

edited

Loading